docs: fix installation and API guidance - #1390
Merged
Merged
Conversation
PsiACE
approved these changes
Aug 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Which issue or RFC does this PR close?
No linked issue.
Rationale for this change
Current user guides contain a few copy-paste and reference gaps: repeated installs from the mutable
masterref may not refresh an existing uv tool, the HTTP examples require a curl option unavailable on older supported environments, authenticated browser access is underspecified, and the configuration reference omits several active inference settings. The CLI and RFC contributor links also point atmainalthough this repository usesmaster.What changes are included in this PR?
uv tool install --forceconsistently in current Git-based installation and integration instructions so an existing tool refreshes the selected ref.curl --fail-with-bodywith the more portablecurl --failin the HTTP examples and document authenticated OpenAPI retrieval.maintomasterin both English and Chinese guidance.No OpenAPI schema, public API, persistence format, or runtime behavior changes are included.
Are there any user-facing changes?
Yes. Installation, deployment, HTTP API, configuration, tutorial, RFC contributor, and integration documentation is clearer and copy-paste compatible. The CLI help now links to the existing documentation branch. There are no breaking changes.
How was this change tested?
make docs-testmake checkmake contract-test(29 passed)uv run pytest tests/test_server.py tests/test_dashboard.py tests/test_server_embedding.py tests/test_api_contract.py tests/test_config_cli.py tests/test_docker_contract.py -q(95 passed)make test(950 passed, 9 skipped)uv tool install --force "powercontext[cli,server] @ git+https://github.com/oceanbase/powercontext.git@master"from the current upstream commitAI usage statement
OpenAI Codex (GPT-5) was used to audit the documentation against the CLI, Server settings, authentication middleware, OpenAPI contract, and runnable installation/API flows; draft the bilingual updates; and run the validation commands. The changes were reviewed against the repository diff before submission.